Skip to content

Add AGENTS.md and CLAUDE.md with build commands and architecture overview#454

Draft
cvolkcvolk wants to merge 7 commits intomainfrom
add-claude-md
Draft

Add AGENTS.md and CLAUDE.md with build commands and architecture overview#454
cvolkcvolk wants to merge 7 commits intomainfrom
add-claude-md

Conversation

@cvolkcvolk
Copy link
Collaborator

@cvolkcvolk cvolkcvolk commented Mar 2, 2026

Summary

  • Adds AGENTS.md as the single source of truth for AI coding agent guidance (Claude Code, OpenAI Codex, etc.)
  • CLAUDE.md redirects to AGENTS.md via @AGENTS.md, inspired by Newton
  • Documents common commands (tests, linting, formatting, DCO sign-off), coding style, contributing guidelines, and high-level architecture

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
@cvolkcvolk cvolkcvolk changed the base branch from release/0.1.1 to main March 2, 2026 09:16
cvolkcvolk and others added 4 commits March 2, 2026 10:19
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
- Add pre-commit workflow note (run before committing, not after)
- Document branch naming, commit message format, and PR iteration rules
- Fix architecture diagram method names (make_registered vs make_rl)
- Add wrapped environment convention section (env.unwrapped usage)

Signed-off-by: Clemens Volk <cvolk@nvidia.com>
@cvolkcvolk cvolkcvolk marked this pull request as draft March 2, 2026 14:02
AGENTS.md is the convention for OpenAI agents; CLAUDE.md is the
convention for Claude Code. By maintaining one source of truth in
AGENTS.md and having CLAUDE.md reference it via @AGENTS.md, both
tools pick up the same guidance.

Signed-off-by: Clemens Volk <cvolk@nvidia.com>
@cvolkcvolk cvolkcvolk changed the title Add CLAUDE.md with build commands and architecture overview Add AGENTS.md and CLAUDE.md with build commands and architecture overview Mar 2, 2026
Remove project overview, architecture, key packages, config system,
and relation solver sections — these are discoverable from the code.
Keep Docker setup, test/lint commands, contributing guidelines, and
non-obvious conventions (wrapped env, test infrastructure pattern).

Signed-off-by: Clemens Volk <cvolk@nvidia.com>
@cvolkcvolk cvolkcvolk closed this Mar 4, 2026
@cvolkcvolk cvolkcvolk deleted the add-claude-md branch March 4, 2026 09:28
@cvolkcvolk cvolkcvolk restored the add-claude-md branch March 18, 2026 21:15
@cvolkcvolk cvolkcvolk reopened this Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant